add linked workspace endpoints(Ready for review) by RichardLi1437 · Pull Request #8918 · Azure/azure-rest-api-specs

RichardLi1437 · 2020-04-02T03:47:45Z

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

azure-pipelines · 2020-04-02T03:48:01Z

Azure Pipelines successfully started running 1 pipeline(s).

openapi-sdkautomation · 2020-04-02T03:49:26Z

azure-sdk-for-net

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 57f4b0c with merge commit ee537703b1a13aa47435ae0cb5c03358923b4409. SDK Automation 13.0.17.20200326.3
️✔️Microsoft.Azure.Management.MachineLearningServices [Logs] [Preview SDK Changes]
No Artifact Generated.

openapi-sdkautomation · 2020-04-02T03:49:26Z

azure-cli-extensions

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 57f4b0c with merge commit ee537703b1a13aa47435ae0cb5c03358923b4409. SDK Automation 13.0.17.20200326.3

[AutoRest] 
[AutoRest] NO TEST SCENARIO PROVIDED - DEFAULT WILL BE USED
[AutoRest] ADD FOLLOWING SECTION TO readme.cli.md FILE TO MODIFY IT
[AutoRest] --------------------------------------------------------
[AutoRest]   test-scenario:
[AutoRest]     - name: Create Workspace
[AutoRest]     - name: CreateLinkedWorkspace
[AutoRest]     - name: Update a AML Compute
[AutoRest]     - name: Update a AKS Compute
[AutoRest]     - name: Create a DataFactory Compute
[AutoRest]     - name: Create a AML Compute
[AutoRest]     - name: Create AKS Compute
[AutoRest]     - name: WorkspaceGetPrivateEndpointConnection
[AutoRest]     - name: Get a AKS Compute
[AutoRest]     - name: Get a AML Compute
[AutoRest]     - name: GetLinkedWorkspace
[AutoRest]     - name: Get Workspace
[AutoRest]     - name: WorkspaceListPrivateLinkResources
[AutoRest]     - name: List Workspace features
[AutoRest]     - name: Get Computes
[AutoRest]     - name: ListLinkedWorkspaces
[AutoRest]     - name: Get Workspaces by Resource Group
[AutoRest]     - name: List VM Sizes
[AutoRest]     - name: List Usages
[AutoRest]     - name: List workspace quotas by VMFamily
[AutoRest]     - name: List Skus
[AutoRest]     - name: Get Workspaces by subscription
[AutoRest]     - name: WorkspacePutPrivateEndpointConnection
[AutoRest]     - name: Get compute nodes information for a compute
[AutoRest]     - name: List AKS Compute Keys
[AutoRest]     - name: Update a AmlCompute Compute
[AutoRest]     - name: UpdateLinkedWorkspace
[AutoRest]     - name: Resync Workspace Keys
[AutoRest]     - name: List Workspace Keys
[AutoRest]     - name: Update Workspace
[AutoRest]     - name: update quotas
[AutoRest]     - name: WorkspaceDeletePrivateEndpointConnection
[AutoRest]     - name: Delete Compute
[AutoRest]     - name: DeleteLinkedWorkspace
[AutoRest]     - name: Delete Workspace
[AutoRest] --------------------------------------------------------

️✔️machinelearningservices [Logs] [Preview SDK Changes]
```
Cli has no registered package commands.
```

openapi-sdkautomation · 2020-04-02T03:49:29Z

azure-sdk-for-java

No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

openapi-sdkautomation · 2020-04-02T03:49:31Z

azure-sdk-for-python

- Breaking Change detected in SDK

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from 57f4b0c with merge commit ee537703b1a13aa47435ae0cb5c03358923b4409. SDK Automation 13.0.17.20200326.3

⚠️azure-mgmt-machinelearningservices [Logs] [Preview SDK Changes] Breaking Change Detected

[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] warning: no files found matching '*.py' under directory 'tests'
[build_package] warning: no files found matching '*.yaml' under directory 'tests'
[build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
[build_package]   warnings.warn(msg)
[build_package] warning: no files found matching '*.py' under directory 'tests'
[build_package] warning: no files found matching '*.yaml' under directory 'tests'
[breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
[breaking_change_setup] Cannot uninstall requirement azure-nspkg, not installed
[breaking_change_setup] Command '['/usr/local/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
[ChangeLog] Size of delta 40.843% size of original (original: 54482 chars, delta: 22252 chars)
[ChangeLog] **Features**
[ChangeLog] 
[ChangeLog]   - Model WorkspaceUpdateParameters has a new parameter sku
[ChangeLog]   - Model Workspace has a new parameter shared_private_link_resources
[ChangeLog]   - Model Workspace has a new parameter sku
[ChangeLog]   - Model Workspace has a new parameter image_build_compute
[ChangeLog]   - Model Workspace has a new parameter private_link_count
[ChangeLog]   - Model Workspace has a new parameter linked_workspaces
[ChangeLog]   - Model Workspace has a new parameter service_provisioned_resource_group
[ChangeLog]   - Model Workspace has a new parameter allow_public_access_when_behind_vnet
[ChangeLog]   - Model Workspace has a new parameter hbi_workspace
[ChangeLog]   - Model Workspace has a new parameter private_endpoint_connections
[ChangeLog]   - Model Workspace has a new parameter encryption
[ChangeLog]   - Model AmlComputeProperties has a new parameter remote_login_port_public_access
[ChangeLog]   - Model Identity has a new parameter user_assigned_identities
[ChangeLog]   - Model ComputeResource has a new parameter sku
[ChangeLog]   - Model Resource has a new parameter sku
[ChangeLog]   - Model VirtualMachineSize has a new parameter gpus
[ChangeLog]   - Added operation group PrivateLinkResourcesOperations
[ChangeLog]   - Added operation group WorkspaceFeaturesOperations
[ChangeLog]   - Added operation group QuotasOperations
[ChangeLog]   - Added operation group AzureMachineLearningWorkspacesOperationsMixin
[ChangeLog]   - Added operation group PrivateEndpointConnectionsOperations
[ChangeLog]   - Added operation group LinkedWorkspacesOperations
[ChangeLog] 
[ChangeLog] **Breaking changes**
[ChangeLog] 
[ChangeLog]   - Model AmlComputeNodeInformation has a new signature

openapi-sdkautomation · 2020-04-02T03:49:31Z

azure-sdk-for-js

️✔️ succeeded [Logs] [Expand Details]

️✔️ Generate from 57f4b0c with merge commit ee537703b1a13aa47435ae0cb5c03358923b4409. SDK Automation 13.0.17.20200326.3

️✔️@azure/arm-machinelearningservices [Logs] [Preview SDK Changes]

azure-arm-machinelearningservices-3.0.0.tgz

[npmPack] npm WARN lifecycle @azure/arm-machinelearningservices@3.0.0~prepack: cannot run in wd @azure/arm-machinelearningservices@3.0.0 npm install && npm run build (wd=/z/work/azure-sdk-for-js/sdk/machinelearningservices/arm-machinelearningservices)

openapi-sdkautomation · 2020-04-02T03:49:32Z

azure-sdk-for-go

⚠️ warning [Logs] [Expand Details]

⚠️ Generate from 57f4b0c with merge commit ee537703b1a13aa47435ae0cb5c03358923b4409. SDK Automation 13.0.17.20200326.3
️✔️machinelearningservices/mgmt/2018-11-19 [Logs] [Preview SDK Changes]
- machinelearningservices.mgmt.2018-11-19.zip
️✔️machinelearningservices/mgmt/2019-05-01 [Logs] [Preview SDK Changes]
- machinelearningservices.mgmt.2019-05-01.zip
️✔️machinelearningservices/mgmt/2019-06-01 [Logs] [Preview SDK Changes]
- machinelearningservices.mgmt.2019-06-01.zip
⚠️machinelearningservices/mgmt/2019-11-01 [Logs]
```
No file is changed.
```
️✔️machinelearningservices/mgmt/2020-01-01 [Logs] [Preview SDK Changes]
- machinelearningservices.mgmt.2020-01-01.zip
️✔️machinelearningservices/mgmt/2020-03-01 [Logs] [Preview SDK Changes]
- machinelearningservices.mgmt.2020-03-01.zip
️✔️preview/machinelearningservices/mgmt/2018-03-01-preview [Logs] [Preview SDK Changes]
- preview.machinelearningservices.mgmt.2018-03-01-preview.zip
️✔️preview/machinelearningservices/mgmt/2020-02-18-preview [Logs] [Preview SDK Changes]
- preview.machinelearningservices.mgmt.2020-02-18-preview.zip

azure-pipelines · 2020-04-02T04:02:05Z

Azure Pipelines successfully started running 1 pipeline(s).

azuresdkci · 2020-04-02T04:24:08Z

Can one of the admins verify this patch?

azure-pipelines · 2020-04-02T04:43:20Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T04:57:11Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T05:13:26Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T05:36:32Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T05:46:27Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T05:52:08Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T06:15:49Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T22:26:20Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T22:33:40Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T23:02:29Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T23:07:49Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-02T23:11:11Z

Azure Pipelines successfully started running 1 pipeline(s).

RichardLi1437 · 2020-04-03T01:07:31Z

Though we introduced new APIs and properties in this PR, we don't want to bump the api-Version right now, because:

Those are not breaking changes, client which not aware of these new APIs won't call the new endpoints, and the new properties in the JSON response will be safely ignored by the JSON deserializer.
These new items are for a new feature that planning to be private preview in May, we want to bump the api-Version by then.
Thank you and looking forward your approval and merge!

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json

majastrz · 2020-04-03T01:14:19Z

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json

+          }
+        }
+      },
+      "post": {


post [](start = 7, length = 4)

Resource updates should be done with PUT not POST as per the RPC. (https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md)

again, that's because LinkedWorkspace is not a resource, yet.

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json

majastrz · 2020-04-03T01:16:17Z

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json

+        }
+      }
+    },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.MachineLearningServices/workspaces/{workspaceName}/delinkWorkspace/{linkName}": {


delinkWorkspace [](start = 133, length = 15)

Are you introducing a separate nested resource type for de-linked workspaces? Did you mean to create a delink POST action on a linked workspace instead?

User can link multiple LinkedWorkspace to Workspace, here is to delink one of them, i.e. delete a LinkedWorkspace. If DELETE is not reserved for resource, I will use DELETE .../linkedWorkspace/{linkName} here. And POST .../linkedWorkspace/{linkName} is used by the update, so I use .../delinkWorkspace/{linkName} here for delete.

majastrz · 2020-04-03T01:18:04Z

...nager/Microsoft.MachineLearningServices/stable/2020-03-01/examples/listLinkedWorkspaces.json

+          "workspaceName": "linkedWorkspace-1234",
+          "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-4321/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai123",
+          "resourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/linkRg-123/providers/Microsoft.Synapse/workspaces/linkedWorkspace-1234"
+        },


This is not an RPC-compliant resource payload. You should have a top level id, 'name, type property and all the resource properties should go into the properties property. Please take a look at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md#resource-api-reference.

LinkedWorkspace is not yet a resource.

RichardLi1437 · 2020-04-03T04:17:15Z

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json

+          "200": {
+            "description": "Successfully deleted the linked workspace."
+          },
+          "204": {


I suppose 204 is ok to be kept?

azure-pipelines · 2020-04-03T04:20:55Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-03T04:21:53Z

Azure Pipelines successfully started running 1 pipeline(s).

azure-pipelines · 2020-04-03T04:22:25Z

Azure Pipelines successfully started running 1 pipeline(s).

add linked workspace endpoints

0b0aa1d

openapi-assignment-bot bot assigned ArcturusZhang Apr 2, 2020

add comma

581191c

fix swagger

acbebef

fix check

54993fa

typo

c4a058a

fix1

5546928

fix2

4bb407f

RichardLi1437 changed the title ~~add linked workspace endpoints~~ add linked workspace endpoints(Not ready for review yet) Apr 2, 2020

fix2

c75f92d

add delink

83b22d7

add 404 response example

0f1d15e

fix4

a3f173a

add linked workspace examples

f3a884d

add examples

cbda199

remove trailing whitespaces

37067e1

openapi-sdkautomation bot mentioned this pull request Apr 2, 2020

[AutoPR machinelearningservices] add linked workspace endpoints(Ready for review) AzureSDKAutomation/azure-cli-extensions#7

Open

RichardLi1437 changed the title ~~add linked workspace endpoints(Not ready for review yet)~~ add linked workspace endpoints(Ready for review) Apr 3, 2020

ArcturusZhang added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Apr 3, 2020

majastrz reviewed Apr 3, 2020

View reviewed changes

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json Show resolved Hide resolved

majastrz reviewed Apr 3, 2020

View reviewed changes

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json Show resolved Hide resolved

majastrz reviewed Apr 3, 2020

View reviewed changes

...rce-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json Outdated Show resolved Hide resolved

majastrz reviewed Apr 3, 2020

View reviewed changes

majastrz added the ARMChangesRequested label Apr 3, 2020

RichardLi1437 commented Apr 3, 2020

View reviewed changes

remove 404

a688022

remove 404

cd46fd0

remove 404

57f4b0c

majastrz added the ARMReviewMeetingRequired label Apr 3, 2020

RichardLi1437 closed this Apr 8, 2020

Conversation

RichardLi1437 commented Apr 2, 2020

Latest improvements:

Contribution checklist:

ARM API Review Checklist

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-net

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-cli-extensions

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-java

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-python

- Breaking Change detected in SDK

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-js

Uh oh!

openapi-sdkautomation bot commented Apr 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

azure-sdk-for-go

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azuresdkci commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

azure-pipelines bot commented Apr 2, 2020

Uh oh!

RichardLi1437 commented Apr 3, 2020

Uh oh!

Uh oh!

Uh oh!

majastrz Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

RichardLi1437 Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

majastrz Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

RichardLi1437 Apr 3, 2020

Choose a reason for hiding this comment

Uh oh!

majastrz Apr 3, 2020

Choose a reason for hiding this comment

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading

openapi-sdkautomation bot commented Apr 2, 2020 •

edited

Loading